fix docs for custom types #242
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
LGTM |
| Both the ``serialize`` and ``deserialize`` methods must be able to | ||
| receive :attr:`colander.null` values and handle them intelligently. This | ||
| will happen whenever the data structure being serialized or deserialized | ||
| does not provide a value for this node. In most cases, ``serialize`` or |
There was a problem hiding this comment.
"In the common case" is deliberately weaker than "in most cases": perhaps "in many cases" instead?
There was a problem hiding this comment.
That's fair. I'll change it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prompted by Issue 151, this improves the accuracy and readability of the Extending Colander section of the docs.
I did not create descriptions for the methods
flatten,unflatten,set_value, orget_value. That might be fodder for another PR, though I'm no longer actively working with Colander, so someone else may need to take up the cause.